/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.configuration;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URL;
import java.util.Iterator;
import java.util.Properties;
import junit.framework.TestCase;
import org.apache.commons.configuration.reloading.FileAlwaysReloadingStrategy;
import org.apache.commons.configuration.reloading.FileChangedReloadingStrategy;
/**
* @author Emmanuel Bourg
* @version $Revision: 711782 $, $Date: 2008-11-06 08:23:41 +0100 (Do, 06 Nov 2008) $
*/
public class TestFileConfiguration extends TestCase
{
/** Constant for the output directory.*/
private static final File TARGET_DIR = new File("target");
/** Constant for the directory with the test configuration files.*/
private static final File TEST_DIR = new File("conf");
/** Constant for the name of a test file.*/
private static final String TEST_FILENAME = "test.properties";
/** Constant for a test file.*/
private static final File TEST_FILE = new File(TEST_DIR, TEST_FILENAME);
/** Constant for the name of a resource to be resolved.*/
private static final String RESOURCE_NAME = "config/deep/deeptest.properties";
public void testSetURL() throws Exception
{
// http URL
FileConfiguration config = new PropertiesConfiguration();
config.setURL(new URL("http://commons.apache.org/configuration/index.html"));
assertEquals("base path", "http://commons.apache.org/configuration/", config.getBasePath());
assertEquals("file name", "index.html", config.getFileName());
// file URL
config.setURL(new URL("file:/temp/test.properties"));
assertEquals("base path", "file:/temp/", config.getBasePath());
assertEquals("file name", "test.properties", config.getFileName());
}
public void testSetURLWithParams() throws Exception
{
FileConfiguration config = new PropertiesConfiguration();
URL url = new URL("http://issues.apache.org/bugzilla/show_bug.cgi?id=37886");
config.setURL(url);
assertEquals("Base path incorrect", "http://issues.apache.org/bugzilla/", config.getBasePath());
assertEquals("File name incorrect", "show_bug.cgi", config.getFileName());
assertEquals("URL was not correctly stored", url, config.getURL());
}
public void testLocations() throws Exception
{
PropertiesConfiguration config = new PropertiesConfiguration();
File directory = TEST_DIR;
File file = TEST_FILE;
config.setFile(file);
assertEquals(directory.getAbsolutePath(), config.getBasePath());
assertEquals(TEST_FILENAME, config.getFileName());
assertEquals(file.getAbsolutePath(), config.getPath());
config.setPath("conf" + File.separator + TEST_FILENAME);
assertEquals(TEST_FILENAME, config.getFileName());
assertEquals(directory.getAbsolutePath(), config.getBasePath());
assertEquals(file.getAbsolutePath(), config.getPath());
assertEquals(file.toURL(), config.getURL());
config.setBasePath(null);
config.setFileName(TEST_FILENAME);
assertNull(config.getBasePath());
assertEquals(TEST_FILENAME, config.getFileName());
}
public void testCreateFile1() throws Exception
{
File file = new File("target/test-resources/foo/bar/test.properties");
if (file.exists())
{
file.delete();
file.getParentFile().delete();
}
assertFalse("The file should not exist", file.exists());
FileConfiguration config = new PropertiesConfiguration(file);
config.save();
assertTrue("The file doesn't exist", file.exists());
}
public void testCreateFile2() throws Exception
{
File file = new File("target/test-resources/foo/bar/test.properties");
if (file.exists())
{
file.delete();
file.getParentFile().delete();
}
assertFalse("The file should not exist", file.exists());
FileConfiguration config = new PropertiesConfiguration();
config.setFile(file);
config.save();
assertTrue("The file doesn't exist", file.exists());
}
public void testCreateFile3() throws Exception
{
File file = new File("target/test-resources/foo/bar/test.properties");
if (file.exists())
{
file.delete();
file.getParentFile().delete();
}
assertFalse("The file should not exist", file.exists());
FileConfiguration config = new PropertiesConfiguration();
config.save(file);
assertTrue("The file doesn't exist", file.exists());
}
/**
* Tests collaboration with ConfigurationFactory: Is the base path set on
* loading is valid in file based configurations?
*
* @throws Exception if an error occurs
*/
public void testWithConfigurationFactory() throws Exception
{
File dir = new File("conf");
File file = new File(dir, "testFileConfiguration.properties");
if (file.exists())
{
assertTrue("File cannot be deleted", file.delete());
}
try
{
ConfigurationFactory factory = new ConfigurationFactory();
factory.setConfigurationURL(new File(dir, "testDigesterConfiguration2.xml").toURL());
CompositeConfiguration cc = (CompositeConfiguration) factory.getConfiguration();
PropertiesConfiguration config = null;
for (int i = 0; config == null; i++)
{
if (cc.getConfiguration(i) instanceof PropertiesConfiguration)
{
config = (PropertiesConfiguration) cc.getConfiguration(i);
}
}
config.setProperty("test", "yes");
config.save(file.getName());
assertTrue(file.exists());
config = new PropertiesConfiguration();
config.setFile(file);
config.load();
assertEquals("yes", config.getProperty("test"));
assertEquals("masterOfPost", config.getProperty("mail.account.user"));
}
finally
{
if (file.exists())
{
assertTrue("File could not be deleted", file.delete());
}
}
}
/**
* Tests if invalid URLs cause an exception.
*/
public void testSaveInvalidURL() throws Exception
{
FileConfiguration config = new PropertiesConfiguration();
try
{
config.save(new URL("http://jakarta.apache.org/test.properties"));
fail("Should throw a ConfigurationException!");
}
catch (ConfigurationException cex)
{
//fine
}
try
{
config.save("http://www.apache.org/test.properties");
fail("Should throw a ConfigurationException!");
}
catch (ConfigurationException cex)
{
//fine
}
}
/**
* Tests if the URL used by the load() method is also used by save().
*/
public void testFileOverwrite() throws Exception
{
FileOutputStream out = null;
FileInputStream in = null;
File tempFile = null;
try
{
String path = System.getProperties().getProperty("user.home");
File homeDir = new File(path);
tempFile = File.createTempFile("CONF", null, homeDir);
String fileName = tempFile.getName();
Properties props = new Properties();
props.setProperty("1", "one");
out = new FileOutputStream(tempFile);
props.store(out, "TestFileOverwrite");
out.close();
out = null;
FileConfiguration config = new PropertiesConfiguration(fileName);
config.load();
String value = config.getString("1");
assertTrue("one".equals(value));
config.setProperty("1", "two");
config.save();
props = new Properties();
in = new FileInputStream(tempFile);
props.load(in);
String value2 = props.getProperty("1");
assertTrue("two".equals(value2));
}
finally
{
if (out != null)
{
try
{
out.close();
}
catch (IOException ioex)
{
ioex.printStackTrace();
}
}
if (in != null)
{
try
{
in.close();
}
catch (IOException ioex)
{
ioex.printStackTrace();
}
}
if (tempFile.exists())
{
assertTrue(tempFile.delete());
}
}
}
/**
* Tests setting a file changed reloading strategy together with the auto
* save feature.
*/
public void testReloadingWithAutoSave() throws Exception
{
File configFile = new File(TARGET_DIR, TEST_FILENAME);
PrintWriter out = null;
try
{
out = new PrintWriter(new FileWriter(configFile));
out.println("a = one");
out.close();
out = null;
PropertiesConfiguration config = new PropertiesConfiguration(
configFile);
config.setReloadingStrategy(new FileChangedReloadingStrategy());
config.setAutoSave(true);
assertEquals("one", config.getProperty("a"));
config.setProperty("b", "two");
assertEquals("one", config.getProperty("a"));
}
finally
{
if (out != null)
{
out.close();
}
if (configFile.exists())
{
assertTrue(configFile.delete());
}
}
}
/**
* Tests loading and saving a configuration file with a complicated path
* name including spaces. (related to issue 35210)
*/
public void testPathWithSpaces() throws Exception
{
File path = new File(TARGET_DIR, "path with spaces");
File confFile = new File(path, "config-test.properties");
PrintWriter out = null;
try
{
if (!path.exists())
{
assertTrue(path.mkdir());
}
out = new PrintWriter(new FileWriter(confFile));
out.println("saved = false");
out.close();
out = null;
URL url = new URL(TARGET_DIR.toURL()
+ "path%20with%20spaces/config-test.properties");
PropertiesConfiguration config = new PropertiesConfiguration(url);
config.load();
assertFalse(config.getBoolean("saved"));
config.setProperty("saved", Boolean.TRUE);
config.save();
config = new PropertiesConfiguration();
config.setFile(confFile);
config.load();
assertTrue(config.getBoolean("saved"));
}
finally
{
if (out != null)
{
out.close();
}
if (confFile.exists())
{
assertTrue(confFile.delete());
}
if (path.exists())
{
assertTrue(path.delete());
}
}
}
/**
* Tests the getFile() method.
*/
public void testGetFile() throws ConfigurationException
{
FileConfiguration config = new PropertiesConfiguration();
assertNull(config.getFile());
File file = TEST_FILE.getAbsoluteFile();
config.setFile(file);
assertEquals(file, config.getFile());
config.load();
assertEquals(file, config.getFile());
}
/**
* Tests whether getFile() returns a valid file after a configuration has
* been loaded.
*/
public void testGetFileAfterLoad() throws ConfigurationException,
IOException
{
FileConfiguration config = new PropertiesConfiguration();
config.load(TEST_FILE.getAbsolutePath());
assertNotNull("No source URL set", config.getURL());
assertEquals("Wrong source file", TEST_FILE.getCanonicalFile(), config
.getFile().getCanonicalFile());
}
/**
* Tests whether calling load() multiple times changes the source. This
* should not be the case.
*/
public void testLoadMultiple() throws ConfigurationException
{
FileConfiguration config = new PropertiesConfiguration();
config.load(TEST_FILE.getAbsolutePath());
URL srcUrl = config.getURL();
File srcFile = config.getFile();
File file2 = new File(TEST_DIR, "testEqual.properties");
config.load(file2.getAbsolutePath());
assertEquals("Source URL was changed", srcUrl, config.getURL());
assertEquals("Source file was changed", srcFile, config.getFile());
}
/**
* Tests to invoke save() without explicitly setting a file name. This
* will cause an exception.
*/
public void testSaveWithoutFileName() throws Exception
{
FileConfiguration config = new PropertiesConfiguration();
File file = TEST_FILE;
config.load(file);
try
{
config.save();
fail("Could save config without setting a file name!");
}
catch(ConfigurationException cex)
{
//ok
}
config = new PropertiesConfiguration();
config.load(TEST_FILE);
try
{
config.save();
fail("Could save config without setting a file name!");
}
catch(ConfigurationException cex)
{
//ok
}
config = new PropertiesConfiguration();
config.load(file.toURL());
try
{
config.save();
fail("Could save config without setting a file name!");
}
catch(ConfigurationException cex)
{
//ok
}
}
/**
* Checks that loading a directory instead of a file throws an exception.
*/
public void testLoadDirectory()
{
PropertiesConfiguration config = new PropertiesConfiguration();
try
{
config.load("target");
fail("Could load config from a directory!");
}
catch (ConfigurationException e)
{
// ok
}
try
{
config.load(new File("target"));
fail("Could load config from a directory!");
}
catch (ConfigurationException e)
{
// ok
}
try
{
new PropertiesConfiguration("target");
fail("Could load config from a directory!");
}
catch (ConfigurationException e)
{
// ok
}
try
{
new PropertiesConfiguration(new File("target"));
fail("Could load config from a directory!");
}
catch (ConfigurationException e)
{
// ok
}
}
/**
* Tests whether the constructor behaves the same as setFileName() when the
* configuration source is in the classpath.
*/
public void testInitFromClassPath() throws ConfigurationException
{
PropertiesConfiguration config1 = new PropertiesConfiguration();
config1.setFileName(RESOURCE_NAME);
config1.load();
PropertiesConfiguration config2 = new PropertiesConfiguration(
RESOURCE_NAME);
compare(config1, config2);
}
/**
* Tests the loading of configuration file in a Combined configuration
* when the configuration source is in the classpath.
*/
public void testLoadFromClassPath() throws ConfigurationException
{
DefaultConfigurationBuilder cf =
new DefaultConfigurationBuilder("conf/config/deep/testFileFromClasspath.xml");
CombinedConfiguration config = cf.getConfiguration(true);
Configuration config1 = config.getConfiguration("propConf");
Configuration config2 = config.getConfiguration("propConfDeep");
compare(config1, config2);
}
/**
* Tests cloning a file based configuration.
*/
public void testClone() throws ConfigurationException
{
PropertiesConfiguration config = new PropertiesConfiguration(
RESOURCE_NAME);
PropertiesConfiguration copy = (PropertiesConfiguration) config.clone();
compare(config, copy);
assertNull("URL was not reset", copy.getURL());
assertNull("Base path was not reset", copy.getBasePath());
assertNull("File name was not reset", copy.getFileName());
assertNotSame("Reloading strategy was not reset", config
.getReloadingStrategy(), copy.getReloadingStrategy());
}
/**
* Tests whether an error log listener was registered at the configuration.
*/
public void testLogErrorListener()
{
PropertiesConfiguration config = new PropertiesConfiguration();
assertEquals("No error log listener registered", 1, config
.getErrorListeners().size());
}
/**
* Tests handling of errors in the reload() method.
*/
public void testReloadError() throws ConfigurationException
{
ConfigurationErrorListenerImpl l = new ConfigurationErrorListenerImpl();
PropertiesConfiguration config = new PropertiesConfiguration(
RESOURCE_NAME);
config.clearErrorListeners();
config.addErrorListener(l);
config.setReloadingStrategy(new FileAlwaysReloadingStrategy());
config.getString("test");
config.setFileName("Not existing file");
config.getString("test");
l.verify(AbstractFileConfiguration.EVENT_RELOAD, null, null);
assertNotNull("Exception is not set", l.getLastEvent().getCause());
}
/**
* Tests iterating over the keys of a non hierarchical file-based
* configuration while a reload happens. This test is related to
* CONFIGURATION-347.
*/
public void testIterationWithReloadFlat() throws ConfigurationException
{
PropertiesConfiguration config = new PropertiesConfiguration(TEST_FILE);
checkIterationWithReload(config);
}
/**
* Tests iterating over the keys of a hierarchical file-based configuration
* while a reload happens. This test is related to CONFIGURATION-347.
*/
public void testIterationWithReloadHierarchical()
throws ConfigurationException
{
XMLConfiguration config = new XMLConfiguration("test.xml");
checkIterationWithReload(config);
}
/**
* Helper method for testing an iteration over the keys of a file-based
* configuration while a reload happens.
*
* @param config the configuration to test
*/
private void checkIterationWithReload(FileConfiguration config)
{
config.setReloadingStrategy(new FileAlwaysReloadingStrategy());
for (Iterator it = config.getKeys(); it.hasNext();)
{
String key = (String) it.next();
assertNotNull("No value for key " + key, config.getProperty(key));
}
}
/**
* Helper method for comparing the content of two configuration objects.
*
* @param config1 the first configuration
* @param config2 the second configuration
*/
private void compare(Configuration config1, Configuration config2)
{
StrictConfigurationComparator cc = new StrictConfigurationComparator();
assertTrue("Configurations are different", cc.compare(config1, config2));
}
}